GeoServer maintains documentation online using a wiki (confluence hosted by codehaus). This documentation may be exported to html and is included with GeoServer as part of the release process.

Confluence Guidelines

These guidelines are used to manage our confluence content:

• Use parent/child pages to form a Table of Contents, this is especiall important as it allows geoserver documentation to be exported into a single pdf reference.
• Use a leading number to organize pages, even though this makes linking difficult it maintains Table of Contents order

Diagram Guidelines

• Attach as png for screen snapshots, or jpeg for interesting coverages
• 600 pixels maximum width
• Where possible generate with SVG (say Inkscape), and attach both diagram.png and diagram.svg

Writing Guidelines

The following writing guidelines are used during documentation review:

• Developer Documentation Writing Guidelines
• User Documentation Writing Guidelines

Please help out an keep the documentation on track and useful.

Exporting GeoServer Documentation

To export geoserver documentation for reference or online help:

1. Open up Documentation.
2. Switch to the Cannot resolve external resource into attachment. BrowseSpace view.
3. Click on !http://docs.codehaus.org/images/icons/exp_16.gif!Export Space
4. Choose an Export format:
   • Html Output - used to export online help for inclusion with GeoServer
   • Pdf Output - used for a document, that can be printed out as a reference
5. Uncheck *Other Options:
   • include comments - not needed
   • Backup attachments - not needed
6. Select Pages to export - export all pages
7. Press the Export button to recieve a zip file